Skip to main content

Pipe Breaks Project Issues Documentation

Overview​

This document summarizes the current state of issues across the Pipe Breaks project repositories as of May 5th 2025.

Repository Status​

pipe_breaks Repository​

  • No open issues found on GitHub
  • This could indicate:
    • Issues are being tracked elsewhere
    • The repository is in a stable state
    • Issues are being managed through a different system

loe_coe_app Repository​

There are 14 open issues, categorized as follows:

1. Core Functionality Issues​

Issue #1: Algorithm Migration​

  • Title: Pipe breaks streamlit app → check status and migration of remaining algorithms
  • Status: Open
  • Assignee: deven-gqc
  • Description: Need to verify and complete migration of remaining algorithms to Streamlit app

Issue #2: Results Display​

  • Title: View results show results from other algorithms
  • Status: Open
  • Labels: enhancement
  • Assignee: deven-gqc
  • Description: Results display showing incorrect algorithm outputs

Issue #8: Dependencies​

  • Title: Dependency conflicts with running certain algorithms
  • Status: Open
  • Assignee: deven-gqc
  • Description: Conflicts between package versions affecting algorithm execution

Issue #10: Output Management​

  • Title: Rework the logic for outputs
  • Status: Open
  • Assignee: deven-gqc
  • Description:
    • Need to restructure output handling
    • Create run_id-based folders
    • Update database state management
    • Equivalent to runs folder structure

Issue #13: Database Connections​

  • Title: Closing connections to the db after closing the app
  • Status: Open
  • Description: Need to ensure proper database connection management and prevent rollbacks

2. Architecture and Organization​

Issue #14: Directory Structure​

  • Title: Needs directory reorg
  • Status: Open
  • Labels: enhancement
  • Assignee: deven-gqc
  • Description:
    • Restructure for Sphinx documentation compatibility
    • Need to organize into proper Python package structure
    • Folders to reorganize:
      • common
      • algorithms
      • settings

Issue #15: Database ORM​

  • Title: Add the sqlalchemy ORM to the app
  • Status: Open
  • Labels: documentation
  • Assignee: deven-gqc
  • Description: Need to implement SQLAlchemy for efficient database management and future scalability

Issue #16: API Issues​

  • Title: API related issues
  • Status: Open
  • Description:
    • Missing fake_data_generation_settings
    • Missing files/attributes
    • Need to add requirements.txt

3. Environment and Deployment​

Issue #6: Colab Integration​

  • Title: Running in colab
  • Status: Open
  • Labels: bug, enhancement
  • Assignee: deven-gqc
  • Description: Issues with running the application in Google Colab environment

Issue #7: Database Configuration​

  • Title: Database settings
  • Status: Open
  • Assignee: deven-gqc
  • Description: Database configuration and settings management

Issue #11: Environment Detection​

  • Title: Detect if env is compute canada
  • Status: Open
  • Labels: enhancement
  • Assignee: deven-gqc
  • Description: Need to implement environment-specific execution paths based on environment variables

4. Code Quality and Maintenance​

Issue #20: Code Formatting​

  • Title: Code format and lint
  • Status: Open
  • Assignee: deven-gqc
  • Description:
    • Indentation needs to change from 4 spaces to 2 spaces
    • Other linting issues to address

Issue #23: Deprecated Algorithms​

  • Title: No longer maintained algorithms
  • Status: Open
  • Labels: enhancement, medium priority
  • Description:
    • xgbse (no activity since Mar 2022)
    • NMTLR (no updates since Apr 2019)
    • Need to find alternatives or maintained implementations

5. Documentation and Planning​

Issue #12: Execution Flow​

  • Title: idef0 for the execution loop of the entire streamlit app
  • Status: Open
  • Description: Need to create comprehensive execution flow diagram including all algorithm states

Key Concerns and Priorities​

  1. Algorithm Maintenance

    • Several algorithms using deprecated packages
    • Need to find alternatives for xgbse and NMTLR

  2. Database Management

    • Connection handling needs improvement
    • Need to implement SQLAlchemy ORM
    • Database settings need review

  3. Code Organization

    • Directory structure needs restructuring
    • Documentation compatibility issues
    • Code formatting standards need implementation

  4. Environment Management

    • Compute Canada environment detection
    • Colab integration issues
    • Dependency conflicts

  5. Output Handling

    • Need to implement run_id-based folder structure
    • Database state management improvements
    • Results display issues

Next Steps​

  1. Prioritize issues based on impact and dependencies
  2. Create implementation plan for critical fixes
  3. Address deprecated algorithm dependencies
  4. Implement database improvements
  5. Restructure code organization
  6. Update documentation and planning diagrams